Skip to content

Inconsistent format in dataclasses.rst #134946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
alesolda opened this issue May 30, 2025 · 0 comments
Closed

Inconsistent format in dataclasses.rst #134946

alesolda opened this issue May 30, 2025 · 0 comments
Labels
docs Documentation in the Doc dir topic-dataclasses

Comments

@alesolda
Copy link

alesolda commented May 30, 2025 •
edited by bedevere-app bot
Loading

Documentation

The dataclasses.rst documentation uses inconsistent formatting for booleans. For example in the section The parameters to @dataclass are:

- ``init``: If true (the default), (...)

vs

- ``unsafe_hash``: If ``False`` (the default) (...)

Linked PRs
@alesolda alesolda added the docs Documentation in the Doc dir label May 30, 2025
alesolda added a commit to alesolda/cpython that referenced this issue May 30, 2025
@alesolda
Docs: fix formatting in dataclasses.rst
9eb96a7 
Fix boolean values formatting by using double backticks
for True/False to improve consistency.

Fixes pythongh-134946
@alesolda alesolda mentioned this issue May 30, 2025
Closed
alesolda added a commit to alesolda/cpython that referenced this issue May 30, 2025
@alesolda
Merge branch 'main' into pythongh-134946-doc-fix-format-dataclasses
16fe4ac
alesolda added a commit to alesolda/cpython that referenced this issue May 30, 2025
@alesolda
Docs: fix formatting in dataclasses.rst
9e527ad 
Correct boolean literals by replacing 'true' with ``True`` for accuracy and consistency.

Resolves pythongh-134946
alesolda added a commit to alesolda/cpython that referenced this issue May 30, 2025
@alesolda
Docs: fix formatting in dataclasses.rst
45ec776 
Correct boolean literals by replacing 'true' with '``True``' for accuracy and consistency.

Resolves pythongh-134946
alesolda added a commit to alesolda/cpython that referenced this issue May 30, 2025
@alesolda
Docs: fix formatting in dataclasses.rst
2d59921 
Correct boolean literals by replacing 'true' with '``True``' for accuracy and consistency.

Resolves pythongh-134946
alesolda added a commit to alesolda/cpython that referenced this issue May 30, 2025
@alesolda
Docs: fix formatting in dataclasses.rst
060dd93 
Correct boolean literals by replacing 'true' with '``True``' for accuracy and consistency.

Resolves pythongh-134946
@alesolda alesolda closed this as completed Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-dataclasses
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-134946 docs: fix formatting in dataclasses.rst alesolda/cpython
2 participants
@alesolda @ZeroIntensity